Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Issue-5662-kotlinstyle #5833

Merged
merged 25 commits into from
Sep 19, 2024
Merged

Issue-5662-kotlinstyle #5833

merged 25 commits into from
Sep 19, 2024

Conversation

tristan81
Copy link
Contributor

Fixes #5662

  • Bulk automated formatting updates on the code base using ktLint --format
  • Multiple manual changes to meet ktLint standard rules including:
  • removal of wildcard imports (standard:no-wildcard-imports)
  • successive KDOC comments (standard:no-consecutive-comments)
  • unexpected indentation (standard:indent)
  • excessive line lengths (standard:max-line-length)
  • class naming (standard:class-naming)
  • try catch spacing (standard:try-catch-finally-spacing)
  • removal of underscores, capitalisation in fun names (standard:function-naming)
  • filename not matching class name (standard:filename)
  • backing property used with private property (standard:backing-property-naming)
  • lexicopgraphical import ordering (standard:import-ordering)

Tests performed (required)
Tested 'app' profile on Virtual Device (Pixel_7_Pro) with API_35

Ran 'All Tests', failures reported, the same failures reported when executed on the unmodified codebase. Unsure if this is a configuration issue like user account or pre-existing issue with the unit tests.

  • AboutActivityTest 9/9
  • LoginActivityTest 3/3
  • MainActivityTest 0/5
  • ProfileActivityTest 0/1
  • ReviewActivityTest 0/1

Screenshots (for UI changes only)

  • None

@tristan81
*.kt: bulk correction of formatting using ktlint --format
4aca2a2
@tristan81
*.kt: replace wildcard imports and second stage auto format ktlint --…
bc7c591 
…format
@tristan81
QuizQuestionTest.kt: modified property names to camel case to meet kt…
1e5d26e 
…lint standard
@tristan81
LevelControllerTest.kt: modified property names to camel case to meet…
07e466c 
… ktlint standard
@tristan81
QuizActivityUnitTest.kt: modified property names to camel case to mee…
b6c943e 
…t ktlint standard
@tristan81
MediaDetailFragmentUnitTests.kt: modified property names to camel cas…
88d853e 
…e to meet ktlint standard
@tristan81
UploadWorker.kt: modified property names to camel case to meet ktlint…
564906a 
… standard
@tristan81
UploadClient.kt: modified property names to camel case to meet ktlint…
ed9a37c 
… standard
@tristan81
BasePagingPresenter.kt: modified property names to camel case to meet…
bcf682f 
… ktlint standard
@tristan81
DescriptionEditActivity.kt: modified property names to camel case to …
a12cd67 
…meet ktlint standard
@tristan81
OnSwipeTouchListener.kt: modified property names to camel case to mee…
0204385 
…t ktlint standard
@tristan81
MediaDetailFragmentUnitTests.kt: corrected excessive line length to m…
94a007c 
…eet ktlint standard
@tristan81
DepictedItem.kt: corrected property name format and catch format to f…
c6dd524 
…or ktlint standard
@tristan81
UploadCategoryAdapter.kt: corrected class definition format to meet k…
45103b5 
…tlint standard
@tristan81
CustomSelectorActivity.kt: reformatted function names to first letter…
b33f562 
… lowercase to meet ktlint standard
@tristan81
MediaDetailFragmentUnitTests.kt: fix string literal indentation to me…
622410d 
…et ktlint standard
@tristan81
NotForUploadDao.kt: file renamed to match class name, new file NotFor…
c2c66e6 
…UploadStatusDao.kt
@tristan81
UploadedDao.kt: file renamed to match class name, new file UploadedSt…
5550901 
…atusDao.kt
@tristan81
Urls.kt: fixed excessive line length for ktLint standard
e074424
@tristan81
Snak_partial.kt & Statement_partial.kt: refactored to remove undersco…
4717ce0 
…res in class names to meet ktLint standard
@tristan81
*.kt: fixed consecutive KDOC error for ktLint
9d9cd5a
@tristan81
PageableBaseDataSourceTest.kt & UploadPresenterTest.kt: fixed excessi…
0e21045 
…ve line lengths to meet ktLint standard
@tristan81
CheckboxTriStatesTest.kt: renamed file to match class name to meet kt…
131dd93 
…Lint standard
@tristan81
.kt: resolved backing-property-naming error in ktLint, made matching …
9dce683 
…properties public, matched names and refactored
@tristan81
TestConnectionFactory.kt: fixed property naming to adhere to ktLint s…
0ccfba5 
…tandard
nicolas-raoul
nicolas-raoul approved these changes Sep 19, 2024
View reviewed changes
Copy link
Member

@nicolas-raoul nicolas-raoul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

App still works as expected, I tried Nearby, notifications, Explore, uploading a few files.
I haven't checked all files but a sample looked good.

@nicolas-raoul nicolas-raoul merged commit 2d82a43 into commons-app:main Sep 19, 2024
1 check passed
@nicolas-raoul
Copy link
Member

Thanks a lot @tristan81 for the fast work!

Just being curious, what tool(s) did you use? :-)

@tristan81
Copy link
Contributor Author

Thanks a lot @tristan81 for the fast work!

Just being curious, what tool(s) did you use? :-)

nothing ground breaking I used the latest version of ktlint, 1 round of autoformat (ktlint --format), then I outputed the remaining errors to an Excel workbook and just ticked them off one by one.

@tristan81 tristan81 deleted the issue-5662-kotlinstyle branch September 20, 2024 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nicolas-raoul nicolas-raoul nicolas-raoul approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fix 119 minor Kotlin styling error
2 participants
@tristan81 @nicolas-raoul